<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>NGUI: Next-Gen UI kit: UIStretch Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI: Next-Gen UI kit
   &#160;<span id="projectnumber">3.7.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_stretch.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_u_i_stretch-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UIStretch Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This script can be used to stretch objects relative to the screen's width and height. The most obvious use would be to create a full-screen background by attaching it to a sprite.  
 <a href="class_u_i_stretch.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UIStretch:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_stretch.png" usemap="#UIStretch_map" alt=""/>
  <map id="UIStretch_map" name="UIStretch_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a29b4c9934878eaf895bc4fc1daf0fad9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9">Style</a> { <br />
&#160;&#160;<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9a6adf97f83acf6453d4a6a4b1070f3754">Style.None</a>, 
<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9ac1b5fa03ecdb95d4a45dd1c40b02527f">Style.Horizontal</a>, 
<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9a06ce2a25e5d12c166a36f654dbea6012">Style.Vertical</a>, 
<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9a130c5b3473c57faa76e2a1c54e26f88e">Style.Both</a>, 
<br />
&#160;&#160;<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9abef0fa75e3d204cbfed3d79858a7b906">Style.BasedOnHeight</a>, 
<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9ae20ca3fa85daf4ba63d80a2b4c5a6a65">Style.FillKeepingRatio</a>, 
<a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9a50d1777a71e5aface0400b58f4e5510c">Style.FitInternalKeepingRatio</a>
<br />
 }</td></tr>
<tr class="separator:a29b4c9934878eaf895bc4fc1daf0fad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a31b547ebc2564011eba49ce90a7eefb0"><td class="memItemLeft" align="right" valign="top">Camera&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a31b547ebc2564011eba49ce90a7eefb0">uiCamera</a> = null</td></tr>
<tr class="memdesc:a31b547ebc2564011eba49ce90a7eefb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Camera used to determine the anchor bounds. Set automatically if none was specified.  <a href="#a31b547ebc2564011eba49ce90a7eefb0">More...</a><br /></td></tr>
<tr class="separator:a31b547ebc2564011eba49ce90a7eefb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a964cba6f9dccd71022fa9e243328599f"><td class="memItemLeft" align="right" valign="top">GameObject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a964cba6f9dccd71022fa9e243328599f">container</a> = null</td></tr>
<tr class="memdesc:a964cba6f9dccd71022fa9e243328599f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object used to determine the container's bounds. Overwrites the camera-based anchoring if the value was specified.  <a href="#a964cba6f9dccd71022fa9e243328599f">More...</a><br /></td></tr>
<tr class="separator:a964cba6f9dccd71022fa9e243328599f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaaee8df5e19642250ab1574426205a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9">Style</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#aeaaee8df5e19642250ab1574426205a2">style</a> = Style.None</td></tr>
<tr class="memdesc:aeaaee8df5e19642250ab1574426205a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stretching style.  <a href="#aeaaee8df5e19642250ab1574426205a2">More...</a><br /></td></tr>
<tr class="separator:aeaaee8df5e19642250ab1574426205a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4460c721609bf0d1062ca8dbbd200d97"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a4460c721609bf0d1062ca8dbbd200d97">runOnlyOnce</a> = true</td></tr>
<tr class="memdesc:a4460c721609bf0d1062ca8dbbd200d97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the operation will occur only once and the script will then be disabled. Screen size changes will still cause the script's logic to execute.  <a href="#a4460c721609bf0d1062ca8dbbd200d97">More...</a><br /></td></tr>
<tr class="separator:a4460c721609bf0d1062ca8dbbd200d97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aece8549fc67a8851d10d7b7fd342a807"><td class="memItemLeft" align="right" valign="top">Vector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#aece8549fc67a8851d10d7b7fd342a807">relativeSize</a> = Vector2.one</td></tr>
<tr class="memdesc:aece8549fc67a8851d10d7b7fd342a807"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relative-to-target size.  <a href="#aece8549fc67a8851d10d7b7fd342a807">More...</a><br /></td></tr>
<tr class="separator:aece8549fc67a8851d10d7b7fd342a807"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a9f3070f4477a7d0305ebf6050c6451"><td class="memItemLeft" align="right" valign="top">Vector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a1a9f3070f4477a7d0305ebf6050c6451">initialSize</a> = Vector2.one</td></tr>
<tr class="memdesc:a1a9f3070f4477a7d0305ebf6050c6451"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size that the item/image should start out initially. Used for FillKeepingRatio, and FitInternalKeepingRatio. Contributed by Dylan Ryan.  <a href="#a1a9f3070f4477a7d0305ebf6050c6451">More...</a><br /></td></tr>
<tr class="separator:a1a9f3070f4477a7d0305ebf6050c6451"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c17f2bf7b2672a600549748d355e3d"><td class="memItemLeft" align="right" valign="top">Vector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_stretch.html#a96c17f2bf7b2672a600549748d355e3d">borderPadding</a> = Vector2.zero</td></tr>
<tr class="memdesc:a96c17f2bf7b2672a600549748d355e3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding applied after the size of the stretched object gets calculated. This value is in pixels.  <a href="#a96c17f2bf7b2672a600549748d355e3d">More...</a><br /></td></tr>
<tr class="separator:a96c17f2bf7b2672a600549748d355e3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This script can be used to stretch objects relative to the screen's width and height. The most obvious use would be to create a full-screen background by attaching it to a sprite. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9">UIStretch.Style</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9a6adf97f83acf6453d4a6a4b1070f3754"></a>None&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9ac1b5fa03ecdb95d4a45dd1c40b02527f"></a>Horizontal&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9a06ce2a25e5d12c166a36f654dbea6012"></a>Vertical&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9a130c5b3473c57faa76e2a1c54e26f88e"></a>Both&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9abef0fa75e3d204cbfed3d79858a7b906"></a>BasedOnHeight&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9ae20ca3fa85daf4ba63d80a2b4c5a6a65"></a>FillKeepingRatio&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a29b4c9934878eaf895bc4fc1daf0fad9a50d1777a71e5aface0400b58f4e5510c"></a>FitInternalKeepingRatio&#160;</td><td class="fielddoc">
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a96c17f2bf7b2672a600549748d355e3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vector2 UIStretch.borderPadding = Vector2.zero</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Padding applied after the size of the stretched object gets calculated. This value is in pixels. </p>

</div>
</div>
<a class="anchor" id="a964cba6f9dccd71022fa9e243328599f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GameObject UIStretch.container = null</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Object used to determine the container's bounds. Overwrites the camera-based anchoring if the value was specified. </p>

</div>
</div>
<a class="anchor" id="a1a9f3070f4477a7d0305ebf6050c6451"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vector2 UIStretch.initialSize = Vector2.one</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The size that the item/image should start out initially. Used for FillKeepingRatio, and FitInternalKeepingRatio. Contributed by Dylan Ryan. </p>

</div>
</div>
<a class="anchor" id="aece8549fc67a8851d10d7b7fd342a807"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vector2 UIStretch.relativeSize = Vector2.one</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Relative-to-target size. </p>

</div>
</div>
<a class="anchor" id="a4460c721609bf0d1062ca8dbbd200d97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIStretch.runOnlyOnce = true</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the operation will occur only once and the script will then be disabled. Screen size changes will still cause the script's logic to execute. </p>

</div>
</div>
<a class="anchor" id="aeaaee8df5e19642250ab1574426205a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_stretch.html#a29b4c9934878eaf895bc4fc1daf0fad9">Style</a> UIStretch.style = Style.None</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stretching style. </p>

</div>
</div>
<a class="anchor" id="a31b547ebc2564011eba49ce90a7eefb0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Camera UIStretch.uiCamera = null</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Camera used to determine the anchor bounds. Set automatically if none was specified. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/NGUI/Assets/NGUI/Scripts/UI/<a class="el" href="_u_i_stretch_8cs.html">UIStretch.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_stretch.html">UIStretch</a></li>
    <li class="footer">Generated on Sat Sep 13 2014 05:29:19 for NGUI: Next-Gen UI kit by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>
